Create a new message for a Shipment

SecurityAuthToken
Request
path Parameters
shipmentId
required
string <uuid>

The id of the shipment

Request Body schema: application/json
required
created_at
string or null <date-time>
id
string or null <uuid>
message
required
string
read
boolean or null
sender_avatar
string or null
sender_id
string or null <uuid>
sender_name
string or null
shipment
required
string <uuid>
updated_at
string or null <date-time>
Responses
201

The newly created ShipmentMessage

Response Schema: application/json
created_at
string or null <date-time>
id
string or null <uuid>
message
required
string
read
boolean or null
sender_avatar
string or null
sender_id
string or null <uuid>
sender_name
string or null
shipment
required
string <uuid>
updated_at
string or null <date-time>
default

Default error response

post/shipments/{shipmentId}/messages/
Request samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "read": true,
  • "sender_avatar": "string",
  • "sender_id": "3194e023-c19f-4a42-9172-9e18d68e3a3a",
  • "sender_name": "string",
  • "shipment": "040451d7-03ba-4b1e-94f7-5cacc36efb36",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "read": true,
  • "sender_avatar": "string",
  • "sender_id": "3194e023-c19f-4a42-9172-9e18d68e3a3a",
  • "sender_name": "string",
  • "shipment": "040451d7-03ba-4b1e-94f7-5cacc36efb36",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Copyright © Shipwell 2024. All right reserved.